home *** CD-ROM | disk | FTP | other *** search
/ Aminet 3 / Aminet 3 - July 1994.iso / Aminet / text / hyper / help.lha / Help / HelpFile.hlp < prev    next >
Encoding:
INI File  |  1994-02-26  |  5.3 KB  |  109 lines

  1. [LANGUAGE english; PAGE 9]
  2. [C;6;B]    The AHelp© Files
  3. [J;1;N]
  4.   AHelp© files are very simple text files containing some information \
  5. for AHelp© program to know about colors, justification, link, etc...
  6.  
  7.   This was made simple to enable anyone which want to have it own \
  8. AHelp© files directory to create and manage it alone. \
  9. Absolutly no compiler is needed. A change takes effect \
  10. just by modifying a file and save it back (If you actually \
  11. have AHelp© program running, the change will not be effective in, \
  12. except if the file was not already loaded.)
  13.  
  14.   To know about all commands available in AHelp©, go read:
  15. [C;3][LINK commands]    All AHelp© file Commands
  16. [J;1]
  17.   All AHelp© files should be in the same directory, first enabling \
  18. an easy way for user to find them and second ensuring a quick AHelp© \
  19. file research. Each AHelp© file may have an icon. The AHelp© directory \
  20. have a specific icon, offered within this product.
  21.   You may not have the AHelp© program within the AHelp© files.
  22.  
  23.   Two special files must be in the main directory. Also \
  24. 'Index.hlp' and 'Dictionary'. The second one is optional. The \
  25. index AHelp© file is always loaded first and, when not available \
  26. or invalid, AHelp© quits right away. The dictionary file is used by \
  27. search command see also:
  28. [C;3][LINK search]    Search Function (Dictionary File)
  29. [J;1]
  30.   The text of AHelp© files has just to be typed like any text. \
  31. If you are using a text editor, you will have to save the files \
  32. as text files, also avoiding any control characters of that editor. \
  33. If you are using a code editor (Like CygnusEditor from CygnusSoft \
  34. Software), you will have to use the character '\' at the end of your \
  35. editor lines which continue on the next editor line. This way you \
  36. can create large paragraphs automatically justified with small lines \
  37. (The sequence backslash \
  38. and return is considered like a null character.) The backslash \
  39. character may otherwise be used within your text.
  40.  
  41.   Tabulation characters are not supported by the list gadget. Also \
  42. that character is available to user wanting nicely presented \
  43. AHelp© files. Those tabulations are all deleted from source file \
  44. before use.
  45.  
  46.   You must be aware of the use of the open bracket character, \
  47. because this is used for commands. If you need that bracket to \
  48. appear also write it twice like in: '[[[['.
  49. [LANGUAGE français]
  50. [C;6;B]    Les Fichiers d'Aide
  51. [J;1;N]
  52.   Les fichiers d'aide sont de simple fichiers de texte contenant \
  53. des informations pour le programme AHelp©, lui indiquant les couleurs, \
  54. la justification, les liens, etc...
  55.  
  56.   Ceci a été simplifié pour permettre à quiconque désirant de \
  57. créer et gérer ces propres fichiers d'aide, de le faire seul. Absolument \
  58. aucune compilation n'est nécessaire. Un changement est effectif \
  59. par la simple modification et sauvegarde d'un fichier d'aide \
  60. (Néanmoins, si vous avez actuellement AHelp© qui fonctionne, le \
  61. dit changement ne sera visible que si le fichier n'avait pas encore \
  62. été chargé).
  63.  
  64.   Pour connaître toutes les commandes existantes dans le \
  65. programme AHelp©, lisez:
  66. [C;3][LINK commands]    Toutes les Commandes de AHelp©
  67. [J;1]
  68.   Tous les fichiers d'aide devraient se trouver dans le même \
  69. répertoire. Tout d'abord ceci permet â l'utilisateur d'avoir \
  70. un accès direct et donc de trouver rapidement le fichier qu'il \
  71. désire. Ensuite AHelp© aura une recherche de fichier plus rapide. \
  72. Chaque fichier d'aide devrait avoir une icône. Le répertoire \
  73. possède une icône spécifique, offerte avec ce produit.
  74.   Vous pouvez séparer le programme d'aide des fichiers d'aide. \
  75. Dans ce cas vous aurez à modifier le chemin d'accès dans les \
  76. icônes.
  77.  
  78.   Il existe deux fichiers spéciaux qui doivent être dans le répertoire \
  79. principal. Il s'agit de 'Index.hlp' et de 'Dictionary'. Le second \
  80. est optionel. Le fichier d'index est toujours chargé le premier et, \
  81. lorsqu'il n'est pas valide ou introuvable, AHelp© quitte immédiatement. \
  82. Le fichier dictionnaire est utilisé par la commande de recherche. \
  83. Pour plus d'information, allez voir:
  84. [C;3][LINK search]    Fonction Chercher (Search - Fichier 'Dictionary')
  85. [J;1]
  86.   Le texte des fichiers d'aide a simplement besoin d'être taper \
  87. comme n'importe quel texte. Si vous utilisez un éditeur de texte, \
  88. il vous faudra sauver le fichier sous forme de fichier texte, de cette \
  89. façon vous éviterez les éventuels caractères de contrôle de cet \
  90. éditeur. Si vous utilisez un éditeur de code (Du genre CygnusEditor \
  91. de CygnusSoft Software), vous serez amené à utiliser le caractère \
  92. '\' à la fin des lignes de l'éditeur, quand le paragraphe courent \
  93. continue sur la ligne suivante de l'éditeur. Ceci permet de créer \
  94. de large paragraphes qui sont automatiquement justifiés, tout en \
  95. écrivant de petites lignes (Notez que la séquence '\' suivie \
  96. d'un retour à la ligne est interpretée comme un caractère null \
  97. est donc supprimée). Le caractère '\' peut néanmoins faire \
  98. partie d'une ligne de texte.
  99.  
  100.   Les caractères de tabulation ne sont pas supportés par le \
  101. gadget de type liste. Ils sont supprimés par le programme AHelp©. \
  102. Donc ils sont disponibles à l'utilisateur désireur d'avoir une jolie \
  103. présentation dans ces fichiers d'aides.
  104.  
  105.   Vous devez faire attention à l'utilisation du crochet ouvrant. \
  106. Celui-ci est utilisé pour les commandes. De ce fait, s'il vous est \
  107. nécessaire d'écrire un crochet ouvrant dans votre texte, il vous \
  108. faudra tapez: '[[[['.
  109.